

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>nlp_architect.pipelines.spacy_bist &mdash; NLP Architect by Intel® AI Lab 0.5.2 documentation</title>
  

  
  
  
  

  
  <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
        <script type="text/javascript" src="../../../_static/jquery.js"></script>
        <script type="text/javascript" src="../../../_static/underscore.js"></script>
        <script type="text/javascript" src="../../../_static/doctools.js"></script>
        <script type="text/javascript" src="../../../_static/language_data.js"></script>
        <script type="text/javascript" src="../../../_static/install.js"></script>
        <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    
    <script type="text/javascript" src="../../../_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../../../_static/nlp_arch_theme.css" type="text/css" />
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto+Mono" type="text/css" />
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:100,900" type="text/css" />
    <link rel="index" title="Index" href="../../../genindex.html" />
    <link rel="search" title="Search" href="../../../search.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="../../../index.html">
          

          
            
            <img src="../../../_static/logo.png" class="logo" alt="Logo"/>
          
          </a>

          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul>
<li class="toctree-l1"><a class="reference internal" href="../../../quick_start.html">Quick start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../publications.html">Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials.html">Jupyter Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../model_zoo.html">Model Zoo</a></li>
</ul>
<p class="caption"><span class="caption-text">NLP/NLU Models</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../tagging/sequence_tagging.html">Sequence Tagging</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../sentiment.html">Sentiment Analysis</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../bist_parser.html">Dependency Parsing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../intent.html">Intent Extraction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lm.html">Language Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../information_extraction.html">Information Extraction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../transformers.html">Transformers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../archived/additional.html">Additional Models</a></li>
</ul>
<p class="caption"><span class="caption-text">Optimized Models</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../quantized_bert.html">Quantized BERT</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../transformers_distillation.html">Transformers Distillation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../sparse_gnmt.html">Sparse Neural Machine Translation</a></li>
</ul>
<p class="caption"><span class="caption-text">Solutions</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../absa_solution.html">Aspect Based Sentiment Analysis</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../term_set_expansion.html">Set Expansion</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../trend_analysis.html">Trend Analysis</a></li>
</ul>
<p class="caption"><span class="caption-text">For Developers</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../generated_api/nlp_architect_api_index.html">nlp_architect API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../developer_guide.html">Developer Guide</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../../index.html">NLP Architect by Intel® AI Lab</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../../../index.html">Docs</a> &raquo;</li>
        
          <li><a href="../../index.html">Module code</a> &raquo;</li>
        
      <li>nlp_architect.pipelines.spacy_bist</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <h1>Source code for nlp_architect.pipelines.spacy_bist</h1><div class="highlight"><pre>
<span></span><span class="c1"># ******************************************************************************</span>
<span class="c1"># Copyright 2017-2018 Intel Corporation</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
<span class="c1"># you may not use this file except in compliance with the License.</span>
<span class="c1"># You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1">#     http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1"># See the License for the specific language governing permissions and</span>
<span class="c1"># limitations under the License.</span>
<span class="c1"># ******************************************************************************</span>
<span class="kn">from</span> <span class="nn">os</span> <span class="kn">import</span> <span class="n">path</span><span class="p">,</span> <span class="n">remove</span><span class="p">,</span> <span class="n">makedirs</span>

<span class="kn">from</span> <span class="nn">nlp_architect.common.core_nlp_doc</span> <span class="kn">import</span> <span class="n">CoreNLPDoc</span>
<span class="kn">from</span> <span class="nn">nlp_architect.data.conll</span> <span class="kn">import</span> <span class="n">ConllEntry</span>
<span class="kn">from</span> <span class="nn">nlp_architect.models.bist_parser</span> <span class="kn">import</span> <span class="n">BISTModel</span>
<span class="kn">from</span> <span class="nn">nlp_architect</span> <span class="kn">import</span> <span class="n">LIBRARY_OUT</span>
<span class="kn">from</span> <span class="nn">nlp_architect.utils.io</span> <span class="kn">import</span> <span class="n">download_unlicensed_file</span><span class="p">,</span> <span class="n">uncompress_file</span>
<span class="kn">from</span> <span class="nn">nlp_architect.utils.io</span> <span class="kn">import</span> <span class="n">validate</span>
<span class="kn">from</span> <span class="nn">nlp_architect.utils.text</span> <span class="kn">import</span> <span class="n">SpacyInstance</span>


<div class="viewcode-block" id="SpacyBISTParser"><a class="viewcode-back" href="../../../generated_api/nlp_architect.pipelines.html#nlp_architect.pipelines.spacy_bist.SpacyBISTParser">[docs]</a><span class="k">class</span> <span class="nc">SpacyBISTParser</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Main class which handles parsing with Spacy-BIST parser.</span>

<span class="sd">    Args:</span>
<span class="sd">        verbose (bool, optional): Controls output verbosity.</span>
<span class="sd">        spacy_model (str, optional): Spacy model to use</span>
<span class="sd">        (see https://spacy.io/api/top-level#spacy.load).</span>
<span class="sd">        bist_model (str, optional): Path to a .model file to load. Defaults pre-trained model&#39;.</span>
<span class="sd">    &quot;&quot;&quot;</span>

    <span class="nb">dir</span> <span class="o">=</span> <span class="n">LIBRARY_OUT</span> <span class="o">/</span> <span class="s2">&quot;bist-pretrained&quot;</span>
    <span class="n">_pretrained</span> <span class="o">=</span> <span class="nb">dir</span> <span class="o">/</span> <span class="s2">&quot;bist.model&quot;</span>

    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">spacy_model</span><span class="o">=</span><span class="s2">&quot;en&quot;</span><span class="p">,</span> <span class="n">bist_model</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="n">validate</span><span class="p">(</span>
            <span class="p">(</span><span class="n">verbose</span><span class="p">,</span> <span class="nb">bool</span><span class="p">),</span> <span class="p">(</span><span class="n">spacy_model</span><span class="p">,</span> <span class="nb">str</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1000</span><span class="p">),</span> <span class="p">(</span><span class="n">bist_model</span><span class="p">,</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="kc">None</span><span class="p">),</span> <span class="nb">str</span><span class="p">),</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1000</span><span class="p">)</span>
        <span class="p">)</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="n">bist_model</span><span class="p">:</span>
            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Using pre-trained BIST model.&quot;</span><span class="p">)</span>
            <span class="n">_download_pretrained_model</span><span class="p">()</span>
            <span class="n">bist_model</span> <span class="o">=</span> <span class="n">SpacyBISTParser</span><span class="o">.</span><span class="n">_pretrained</span>

        <span class="bp">self</span><span class="o">.</span><span class="n">verbose</span> <span class="o">=</span> <span class="n">verbose</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">bist_parser</span> <span class="o">=</span> <span class="n">BISTModel</span><span class="p">()</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">bist_parser</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">bist_model</span> <span class="k">if</span> <span class="n">bist_model</span> <span class="k">else</span> <span class="n">SpacyBISTParser</span><span class="o">.</span><span class="n">_pretrained</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">spacy_parser</span> <span class="o">=</span> <span class="n">SpacyInstance</span><span class="p">(</span><span class="n">spacy_model</span><span class="p">,</span> <span class="n">disable</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;ner&quot;</span><span class="p">,</span> <span class="s2">&quot;vectors&quot;</span><span class="p">,</span> <span class="s2">&quot;textcat&quot;</span><span class="p">])</span><span class="o">.</span><span class="n">parser</span>

<div class="viewcode-block" id="SpacyBISTParser.to_conll"><a class="viewcode-back" href="../../../generated_api/nlp_architect.pipelines.html#nlp_architect.pipelines.spacy_bist.SpacyBISTParser.to_conll">[docs]</a>    <span class="k">def</span> <span class="nf">to_conll</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">doc_text</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Converts a document to CoNLL format with spacy POS tags.</span>

<span class="sd">        Args:</span>
<span class="sd">            doc_text (str): raw document text.</span>

<span class="sd">        Yields:</span>
<span class="sd">            list of ConllEntry: The next sentence in the document in CoNLL format.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">validate</span><span class="p">((</span><span class="n">doc_text</span><span class="p">,</span> <span class="nb">str</span><span class="p">))</span>
        <span class="k">for</span> <span class="n">sentence</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">spacy_parser</span><span class="p">(</span><span class="n">doc_text</span><span class="p">)</span><span class="o">.</span><span class="n">sents</span><span class="p">:</span>
            <span class="n">sentence_conll</span> <span class="o">=</span> <span class="p">[</span>
                <span class="n">ConllEntry</span><span class="p">(</span>
                    <span class="mi">0</span><span class="p">,</span> <span class="s2">&quot;*root*&quot;</span><span class="p">,</span> <span class="s2">&quot;*root*&quot;</span><span class="p">,</span> <span class="s2">&quot;ROOT-POS&quot;</span><span class="p">,</span> <span class="s2">&quot;ROOT-CPOS&quot;</span><span class="p">,</span> <span class="s2">&quot;_&quot;</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="s2">&quot;rroot&quot;</span><span class="p">,</span> <span class="s2">&quot;_&quot;</span><span class="p">,</span> <span class="s2">&quot;_&quot;</span>
                <span class="p">)</span>
            <span class="p">]</span>
            <span class="n">i_tok</span> <span class="o">=</span> <span class="mi">0</span>
            <span class="k">for</span> <span class="n">tok</span> <span class="ow">in</span> <span class="n">sentence</span><span class="p">:</span>
                <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">verbose</span><span class="p">:</span>
                    <span class="nb">print</span><span class="p">(</span><span class="n">tok</span><span class="o">.</span><span class="n">text</span> <span class="o">+</span> <span class="s2">&quot;</span><span class="se">\t</span><span class="s2">&quot;</span> <span class="o">+</span> <span class="n">tok</span><span class="o">.</span><span class="n">tag_</span><span class="p">)</span>

                <span class="k">if</span> <span class="ow">not</span> <span class="n">tok</span><span class="o">.</span><span class="n">is_space</span><span class="p">:</span>
                    <span class="n">pos</span> <span class="o">=</span> <span class="n">tok</span><span class="o">.</span><span class="n">tag_</span>
                    <span class="n">text</span> <span class="o">=</span> <span class="n">tok</span><span class="o">.</span><span class="n">text</span>

                    <span class="k">if</span> <span class="n">text</span> <span class="o">!=</span> <span class="s2">&quot;-&quot;</span> <span class="ow">or</span> <span class="n">pos</span> <span class="o">!=</span> <span class="s2">&quot;HYPH&quot;</span><span class="p">:</span>
                        <span class="n">pos</span> <span class="o">=</span> <span class="n">_spacy_pos_to_ptb</span><span class="p">(</span><span class="n">pos</span><span class="p">,</span> <span class="n">text</span><span class="p">)</span>
                        <span class="n">token_conll</span> <span class="o">=</span> <span class="n">ConllEntry</span><span class="p">(</span>
                            <span class="n">i_tok</span> <span class="o">+</span> <span class="mi">1</span><span class="p">,</span>
                            <span class="n">text</span><span class="p">,</span>
                            <span class="n">tok</span><span class="o">.</span><span class="n">lemma_</span><span class="p">,</span>
                            <span class="n">pos</span><span class="p">,</span>
                            <span class="n">pos</span><span class="p">,</span>
                            <span class="n">tok</span><span class="o">.</span><span class="n">ent_type_</span><span class="p">,</span>
                            <span class="o">-</span><span class="mi">1</span><span class="p">,</span>
                            <span class="s2">&quot;_&quot;</span><span class="p">,</span>
                            <span class="s2">&quot;_&quot;</span><span class="p">,</span>
                            <span class="n">tok</span><span class="o">.</span><span class="n">idx</span><span class="p">,</span>
                        <span class="p">)</span>
                        <span class="n">sentence_conll</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">token_conll</span><span class="p">)</span>
                        <span class="n">i_tok</span> <span class="o">+=</span> <span class="mi">1</span>

            <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">verbose</span><span class="p">:</span>
                <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;-----------------------</span><span class="se">\n</span><span class="s2">input conll form:&quot;</span><span class="p">)</span>
                <span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">sentence_conll</span><span class="p">:</span>
                    <span class="nb">print</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">entry</span><span class="o">.</span><span class="n">id</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;</span><span class="se">\t</span><span class="s2">&quot;</span> <span class="o">+</span> <span class="n">entry</span><span class="o">.</span><span class="n">form</span> <span class="o">+</span> <span class="s2">&quot;</span><span class="se">\t</span><span class="s2">&quot;</span> <span class="o">+</span> <span class="n">entry</span><span class="o">.</span><span class="n">pos</span> <span class="o">+</span> <span class="s2">&quot;</span><span class="se">\t</span><span class="s2">&quot;</span><span class="p">)</span>
            <span class="k">yield</span> <span class="n">sentence_conll</span></div>

<div class="viewcode-block" id="SpacyBISTParser.parse"><a class="viewcode-back" href="../../../generated_api/nlp_architect.pipelines.html#nlp_architect.pipelines.spacy_bist.SpacyBISTParser.parse">[docs]</a>    <span class="k">def</span> <span class="nf">parse</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">doc_text</span><span class="p">,</span> <span class="n">show_tok</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">show_doc</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Parse a raw text document.</span>

<span class="sd">        Args:</span>
<span class="sd">            doc_text (str)</span>
<span class="sd">            show_tok (bool, optional): Specifies whether to include token text in output.</span>
<span class="sd">            show_doc (bool, optional): Specifies whether to include document text in output.</span>

<span class="sd">        Returns:</span>
<span class="sd">            CoreNLPDoc: The annotated document.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">validate</span><span class="p">((</span><span class="n">doc_text</span><span class="p">,</span> <span class="nb">str</span><span class="p">),</span> <span class="p">(</span><span class="n">show_tok</span><span class="p">,</span> <span class="nb">bool</span><span class="p">),</span> <span class="p">(</span><span class="n">show_doc</span><span class="p">,</span> <span class="nb">bool</span><span class="p">))</span>
        <span class="n">doc_conll</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">to_conll</span><span class="p">(</span><span class="n">doc_text</span><span class="p">)</span>
        <span class="n">parsed_doc</span> <span class="o">=</span> <span class="n">CoreNLPDoc</span><span class="p">()</span>

        <span class="k">if</span> <span class="n">show_doc</span><span class="p">:</span>
            <span class="n">parsed_doc</span><span class="o">.</span><span class="n">doc_text</span> <span class="o">=</span> <span class="n">doc_text</span>

        <span class="k">for</span> <span class="n">sent_conll</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">bist_parser</span><span class="o">.</span><span class="n">predict_conll</span><span class="p">(</span><span class="n">doc_conll</span><span class="p">):</span>
            <span class="n">parsed_sent</span> <span class="o">=</span> <span class="p">[]</span>
            <span class="n">conj_governors</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;and&quot;</span><span class="p">:</span> <span class="nb">set</span><span class="p">(),</span> <span class="s2">&quot;or&quot;</span><span class="p">:</span> <span class="nb">set</span><span class="p">()}</span>

            <span class="k">for</span> <span class="n">tok</span> <span class="ow">in</span> <span class="n">sent_conll</span><span class="p">:</span>
                <span class="n">gov_id</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">tok</span><span class="o">.</span><span class="n">pred_parent_id</span><span class="p">)</span>
                <span class="n">rel</span> <span class="o">=</span> <span class="n">tok</span><span class="o">.</span><span class="n">pred_relation</span>

                <span class="k">if</span> <span class="n">tok</span><span class="o">.</span><span class="n">form</span> <span class="o">!=</span> <span class="s2">&quot;*root*&quot;</span><span class="p">:</span>
                    <span class="k">if</span> <span class="n">tok</span><span class="o">.</span><span class="n">form</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s2">&quot;and&quot;</span><span class="p">:</span>
                        <span class="n">conj_governors</span><span class="p">[</span><span class="s2">&quot;and&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">gov_id</span><span class="p">)</span>
                    <span class="k">if</span> <span class="n">tok</span><span class="o">.</span><span class="n">form</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s2">&quot;or&quot;</span><span class="p">:</span>
                        <span class="n">conj_governors</span><span class="p">[</span><span class="s2">&quot;or&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">gov_id</span><span class="p">)</span>

                    <span class="k">if</span> <span class="n">rel</span> <span class="o">==</span> <span class="s2">&quot;conj&quot;</span><span class="p">:</span>
                        <span class="k">if</span> <span class="n">gov_id</span> <span class="ow">in</span> <span class="n">conj_governors</span><span class="p">[</span><span class="s2">&quot;and&quot;</span><span class="p">]:</span>
                            <span class="n">rel</span> <span class="o">+=</span> <span class="s2">&quot;_and&quot;</span>
                        <span class="k">if</span> <span class="n">gov_id</span> <span class="ow">in</span> <span class="n">conj_governors</span><span class="p">[</span><span class="s2">&quot;or&quot;</span><span class="p">]:</span>
                            <span class="n">rel</span> <span class="o">+=</span> <span class="s2">&quot;_or&quot;</span>

                    <span class="n">parsed_tok</span> <span class="o">=</span> <span class="p">{</span>
                        <span class="s2">&quot;start&quot;</span><span class="p">:</span> <span class="n">tok</span><span class="o">.</span><span class="n">misc</span><span class="p">,</span>
                        <span class="s2">&quot;len&quot;</span><span class="p">:</span> <span class="nb">len</span><span class="p">(</span><span class="n">tok</span><span class="o">.</span><span class="n">form</span><span class="p">),</span>
                        <span class="s2">&quot;pos&quot;</span><span class="p">:</span> <span class="n">tok</span><span class="o">.</span><span class="n">pos</span><span class="p">,</span>
                        <span class="s2">&quot;ner&quot;</span><span class="p">:</span> <span class="n">tok</span><span class="o">.</span><span class="n">feats</span><span class="p">,</span>
                        <span class="s2">&quot;lemma&quot;</span><span class="p">:</span> <span class="n">tok</span><span class="o">.</span><span class="n">lemma</span><span class="p">,</span>
                        <span class="s2">&quot;gov&quot;</span><span class="p">:</span> <span class="n">gov_id</span> <span class="o">-</span> <span class="mi">1</span><span class="p">,</span>
                        <span class="s2">&quot;rel&quot;</span><span class="p">:</span> <span class="n">rel</span><span class="p">,</span>
                    <span class="p">}</span>

                    <span class="k">if</span> <span class="n">show_tok</span><span class="p">:</span>
                        <span class="n">parsed_tok</span><span class="p">[</span><span class="s2">&quot;text&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">tok</span><span class="o">.</span><span class="n">form</span>
                    <span class="n">parsed_sent</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">parsed_tok</span><span class="p">)</span>
            <span class="k">if</span> <span class="n">parsed_sent</span><span class="p">:</span>
                <span class="n">parsed_doc</span><span class="o">.</span><span class="n">sentences</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">parsed_sent</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">parsed_doc</span></div></div>


<span class="k">def</span> <span class="nf">_download_pretrained_model</span><span class="p">():</span>
    <span class="sd">&quot;&quot;&quot;Downloads the pre-trained BIST model if non-existent.&quot;&quot;&quot;</span>
    <span class="k">if</span> <span class="ow">not</span> <span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">SpacyBISTParser</span><span class="o">.</span><span class="n">dir</span> <span class="o">/</span> <span class="s2">&quot;bist.model&quot;</span><span class="p">):</span>
        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Downloading pre-trained BIST model...&quot;</span><span class="p">)</span>
        <span class="n">zip_path</span> <span class="o">=</span> <span class="n">SpacyBISTParser</span><span class="o">.</span><span class="n">dir</span> <span class="o">/</span> <span class="s2">&quot;bist-pretrained.zip&quot;</span>
        <span class="n">makedirs</span><span class="p">(</span><span class="n">SpacyBISTParser</span><span class="o">.</span><span class="n">dir</span><span class="p">,</span> <span class="n">exist_ok</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
        <span class="n">download_unlicensed_file</span><span class="p">(</span>
            <span class="s2">&quot;https://d2zs9tzlek599f.cloudfront.net/models/dep_parse/&quot;</span><span class="p">,</span>
            <span class="s2">&quot;bist-pretrained.zip&quot;</span><span class="p">,</span>
            <span class="n">zip_path</span><span class="p">,</span>
        <span class="p">)</span>
        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Unzipping...&quot;</span><span class="p">)</span>
        <span class="n">uncompress_file</span><span class="p">(</span><span class="n">zip_path</span><span class="p">,</span> <span class="n">outpath</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">SpacyBISTParser</span><span class="o">.</span><span class="n">dir</span><span class="p">))</span>
        <span class="n">remove</span><span class="p">(</span><span class="n">zip_path</span><span class="p">)</span>
        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Done.&quot;</span><span class="p">)</span>


<span class="k">def</span> <span class="nf">_spacy_pos_to_ptb</span><span class="p">(</span><span class="n">pos</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    Converts a Spacy part-of-speech tag to a Penn Treebank part-of-speech tag.</span>

<span class="sd">    Args:</span>
<span class="sd">        pos (str): Spacy POS tag.</span>
<span class="sd">        text (str): The token text.</span>

<span class="sd">    Returns:</span>
<span class="sd">        ptb_tag (str): Standard PTB POS tag.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="n">validate</span><span class="p">((</span><span class="n">pos</span><span class="p">,</span> <span class="nb">str</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">30</span><span class="p">),</span> <span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="nb">str</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1000</span><span class="p">))</span>
    <span class="n">ptb_tag</span> <span class="o">=</span> <span class="n">pos</span>
    <span class="k">if</span> <span class="n">text</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">&quot;...&quot;</span><span class="p">,</span> <span class="s2">&quot;—&quot;</span><span class="p">]:</span>
        <span class="n">ptb_tag</span> <span class="o">=</span> <span class="s2">&quot;:&quot;</span>
    <span class="k">elif</span> <span class="n">text</span> <span class="o">==</span> <span class="s2">&quot;*&quot;</span><span class="p">:</span>
        <span class="n">ptb_tag</span> <span class="o">=</span> <span class="s2">&quot;SYM&quot;</span>
    <span class="k">elif</span> <span class="n">pos</span> <span class="o">==</span> <span class="s2">&quot;AFX&quot;</span><span class="p">:</span>
        <span class="n">ptb_tag</span> <span class="o">=</span> <span class="s2">&quot;JJ&quot;</span>
    <span class="k">elif</span> <span class="n">pos</span> <span class="o">==</span> <span class="s2">&quot;ADD&quot;</span><span class="p">:</span>
        <span class="n">ptb_tag</span> <span class="o">=</span> <span class="s2">&quot;NN&quot;</span>
    <span class="k">elif</span> <span class="n">text</span> <span class="o">!=</span> <span class="n">pos</span> <span class="ow">and</span> <span class="n">text</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">&quot;,&quot;</span><span class="p">,</span> <span class="s2">&quot;.&quot;</span><span class="p">,</span> <span class="s2">&quot;:&quot;</span><span class="p">,</span> <span class="s2">&quot;``&quot;</span><span class="p">,</span> <span class="s2">&quot;-RRB-&quot;</span><span class="p">,</span> <span class="s2">&quot;-LRB-&quot;</span><span class="p">]:</span>
        <span class="n">ptb_tag</span> <span class="o">=</span> <span class="n">text</span>
    <span class="k">elif</span> <span class="n">pos</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">&quot;NFP&quot;</span><span class="p">,</span> <span class="s2">&quot;HYPH&quot;</span><span class="p">,</span> <span class="s2">&quot;XX&quot;</span><span class="p">]:</span>
        <span class="n">ptb_tag</span> <span class="o">=</span> <span class="s2">&quot;SYM&quot;</span>
    <span class="k">return</span> <span class="n">ptb_tag</span>
</pre></div>

           </div>
           
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>